// Adapted from https://github.com/ueman/sentry-dart-tools/blob/8e41418c0f2c62dc88292cf32a4f22e79112b744/sentry_plus/lib/src/file/sentry_file.dart
//                                Apache License
//                          Version 2.0, January 2004
//                       http://www.apache.org/licenses/

//  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

//  1. Definitions.

//     "License" shall mean the terms and conditions for use, reproduction,
//     and distribution as defined by Sections 1 through 9 of this document.

//     "Licensor" shall mean the copyright owner or entity authorized by
//     the copyright owner that is granting the License.

//     "Legal Entity" shall mean the union of the acting entity and all
//     other entities that control, are controlled by, or are under common
//     control with that entity. For the purposes of this definition,
//     "control" means (i) the power, direct or indirect, to cause the
//     direction or management of such entity, whether by contract or
//     otherwise, or (ii) ownership of fifty percent (50%) or more of the
//     outstanding shares, or (iii) beneficial ownership of such entity.

//     "You" (or "Your") shall mean an individual or Legal Entity
//     exercising permissions granted by this License.

//     "Source" form shall mean the preferred form for making modifications,
//     including but not limited to software source code, documentation
//     source, and configuration files.

//     "Object" form shall mean any form resulting from mechanical
//     transformation or translation of a Source form, including but
//     not limited to compiled object code, generated documentation,
//     and conversions to other media types.

//     "Work" shall mean the work of authorship, whether in Source or
//     Object form, made available under the License, as indicated by a
//     copyright notice that is included in or attached to the work
//     (an example is provided in the Appendix below).

//     "Derivative Works" shall mean any work, whether in Source or Object
//     form, that is based on (or derived from) the Work and for which the
//     editorial revisions, annotations, elaborations, or other modifications
//     represent, as a whole, an original work of authorship. For the purposes
//     of this License, Derivative Works shall not include works that remain
//     separable from, or merely link (or bind by name) to the interfaces of,
//     the Work and Derivative Works thereof.

//     "Contribution" shall mean any work of authorship, including
//     the original version of the Work and any modifications or additions
//     to that Work or Derivative Works thereof, that is intentionally
//     submitted to Licensor for inclusion in the Work by the copyright owner
//     or by an individual or Legal Entity authorized to submit on behalf of
//     the copyright owner. For the purposes of this definition, "submitted"
//     means any form of electronic, verbal, or written communication sent
//     to the Licensor or its representatives, including but not limited to
//     communication on electronic mailing lists, source code control systems,
//     and issue tracking systems that are managed by, or on behalf of, the
//     Licensor for the purpose of discussing and improving the Work, but
//     excluding communication that is conspicuously marked or otherwise
//     designated in writing by the copyright owner as "Not a Contribution."

//     "Contributor" shall mean Licensor and any individual or Legal Entity
//     on behalf of whom a Contribution has been received by Licensor and
//     subsequently incorporated within the Work.

//  2. Grant of Copyright License. Subject to the terms and conditions of
//     this License, each Contributor hereby grants to You a perpetual,
//     worldwide, non-exclusive, no-charge, royalty-free, irrevocable
//     copyright license to reproduce, prepare Derivative Works of,
//     publicly display, publicly perform, sublicense, and distribute the
//     Work and such Derivative Works in Source or Object form.

//  3. Grant of Patent License. Subject to the terms and conditions of
//     this License, each Contributor hereby grants to You a perpetual,
//     worldwide, non-exclusive, no-charge, royalty-free, irrevocable
//     (except as stated in this section) patent license to make, have made,
//     use, offer to sell, sell, import, and otherwise transfer the Work,
//     where such license applies only to those patent claims licensable
//     by such Contributor that are necessarily infringed by their
//     Contribution(s) alone or by combination of their Contribution(s)
//     with the Work to which such Contribution(s) was submitted. If You
//     institute patent litigation against any entity (including a
//     cross-claim or counterclaim in a lawsuit) alleging that the Work
//     or a Contribution incorporated within the Work constitutes direct
//     or contributory patent infringement, then any patent licenses
//     granted to You under this License for that Work shall terminate
//     as of the date such litigation is filed.

//  4. Redistribution. You may reproduce and distribute copies of the
//     Work or Derivative Works thereof in any medium, with or without
//     modifications, and in Source or Object form, provided that You
//     meet the following conditions:

//     (a) You must give any other recipients of the Work or
//         Derivative Works a copy of this License; and

//     (b) You must cause any modified files to carry prominent notices
//         stating that You changed the files; and

//     (c) You must retain, in the Source form of any Derivative Works
//         that You distribute, all copyright, patent, trademark, and
//         attribution notices from the Source form of the Work,
//         excluding those notices that do not pertain to any part of
//         the Derivative Works; and

//     (d) If the Work includes a "NOTICE" text file as part of its
//         distribution, then any Derivative Works that You distribute must
//         include a readable copy of the attribution notices contained
//         within such NOTICE file, excluding those notices that do not
//         pertain to any part of the Derivative Works, in at least one
//         of the following places: within a NOTICE text file distributed
//         as part of the Derivative Works; within the Source form or
//         documentation, if provided along with the Derivative Works; or,
//         within a display generated by the Derivative Works, if and
//         wherever such third-party notices normally appear. The contents
//         of the NOTICE file are for informational purposes only and
//         do not modify the License. You may add Your own attribution
//         notices within Derivative Works that You distribute, alongside
//         or as an addendum to the NOTICE text from the Work, provided
//         that such additional attribution notices cannot be construed
//         as modifying the License.

//     You may add Your own copyright statement to Your modifications and
//     may provide additional or different license terms and conditions
//     for use, reproduction, or distribution of Your modifications, or
//     for any such Derivative Works as a whole, provided Your use,
//     reproduction, and distribution of the Work otherwise complies with
//     the conditions stated in this License.

//  5. Submission of Contributions. Unless You explicitly state otherwise,
//     any Contribution intentionally submitted for inclusion in the Work
//     by You to the Licensor shall be under the terms and conditions of
//     this License, without any additional terms or conditions.
//     Notwithstanding the above, nothing herein shall supersede or modify
//     the terms of any separate license agreement you may have executed
//     with Licensor regarding such Contributions.

//  6. Trademarks. This License does not grant permission to use the trade
//     names, trademarks, service marks, or product names of the Licensor,
//     except as required for reasonable and customary use in describing the
//     origin of the Work and reproducing the content of the NOTICE file.

//  7. Disclaimer of Warranty. Unless required by applicable law or
//     agreed to in writing, Licensor provides the Work (and each
//     Contributor provides its Contributions) on an "AS IS" BASIS,
//     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
//     implied, including, without limitation, any warranties or conditions
//     of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
//     PARTICULAR PURPOSE. You are solely responsible for determining the
//     appropriateness of using or redistributing the Work and assume any
//     risks associated with Your exercise of permissions under this License.

//  8. Limitation of Liability. In no event and under no legal theory,
//     whether in tort (including negligence), contract, or otherwise,
//     unless required by applicable law (such as deliberate and grossly
//     negligent acts) or agreed to in writing, shall any Contributor be
//     liable to You for damages, including any direct, indirect, special,
//     incidental, or consequential damages of any character arising as a
//     result of this License or out of the use or inability to use the
//     Work (including but not limited to damages for loss of goodwill,
//     work stoppage, computer failure or malfunction, or any and all
//     other commercial damages or losses), even if such Contributor
//     has been advised of the possibility of such damages.

//  9. Accepting Warranty or Additional Liability. While redistributing
//     the Work or Derivative Works thereof, You may choose to offer,
//     and charge a fee for, acceptance of support, warranty, indemnity,
//     or other liability obligations and/or rights consistent with this
//     License. However, in accepting such obligations, You may act only
//     on Your own behalf and on Your sole responsibility, not on behalf
//     of any other Contributor, and only if You agree to indemnify,
//     defend, and hold each Contributor harmless for any liability
//     incurred by, or claims asserted against, such Contributor by reason
//     of your accepting any such warranty or additional liability.

//  END OF TERMS AND CONDITIONS

//  APPENDIX: How to apply the Apache License to your work.

//     To apply the Apache License to your work, attach the following
//     boilerplate notice, with the fields enclosed by brackets "[]"
//     replaced with your own identifying information. (Don't include
//     the brackets!)  The text should be enclosed in the appropriate
//     comment syntax for the file format. We also recommend that a
//     file or class name and description of purpose be included on the
//     same "printed page" as the copyright notice for easier
//     identification within third-party archives.

//  Copyright 2022 Jonas Uekötter

//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at

//      http://www.apache.org/licenses/LICENSE-2.0

//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

// ignore_for_file: invalid_use_of_internal_member

import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';
import 'package:meta/meta.dart';
import 'package:sentry/sentry.dart';

import 'version.dart';

typedef Callback<T> = FutureOr<T> Function();

/// The Sentry wrapper for the File IO implementation that creates a span
/// out of the active transaction in the scope and a breadcrumb, which gets
/// added to the hub.
/// The span is started before the operation is executed and finished after.
/// The File tracing isn't available for Web.
///
/// Example:
///
/// ```dart
/// import 'dart:io';
///
/// final file = File('test.txt');
/// final sentryFile = SentryFile(file);
/// // span starts
/// await sentryFile.writeAsString('Hello World');
/// // span finishes, adds breadcrumb
/// ```
///
/// All the copy, create, delete, open, rename, read, and write operations are
/// supported.
class SentryFile implements File {
  SentryFile(
    this._file, {
    @internal Hub? hub,
  }) : _hub = hub ?? HubAdapter() {
    _hub.options.sdk.addIntegration('SentryFileTracing');
    _hub.options.sdk.addPackage(packageName, sdkVersion);
  }

  final File _file;
  final Hub _hub;

  @override
  Future<File> copy(String newPath) {
    return _wrap(() async => _file.copy(newPath), 'file.copy');
  }

  @override
  File copySync(String newPath) {
    return _wrapSync(() => _file.copySync(newPath), 'file.copy');
  }

  @override
  Future<File> create({bool recursive = false, bool exclusive = false}) {
    return _wrap(
      () async => _file.create(recursive: recursive, exclusive: exclusive),
      'file.write',
    );
  }

  @override
  void createSync({bool recursive = false, bool exclusive = false}) {
    return _wrapSync(
      () => _file.createSync(recursive: recursive, exclusive: exclusive),
      'file.write',
    );
  }

  @override
  Future<FileSystemEntity> delete({bool recursive = false}) {
    return _wrap(() async => _file.delete(recursive: recursive), 'file.delete');
  }

  @override
  void deleteSync({bool recursive = false}) {
    _wrapSync(() => _file.deleteSync(recursive: recursive), 'file.delete');
  }

  @override
  Future<RandomAccessFile> open({FileMode mode = FileMode.read}) {
    return _wrap(() async => _file.open(mode: mode), 'file.open');
  }

  // coverage:ignore-start

  @override
  Stream<List<int>> openRead([int? start, int? end]) {
    return _file.openRead(start, end);
  }

  @override
  RandomAccessFile openSync({FileMode mode = FileMode.read}) {
    return _file.openSync(mode: mode);
  }

  @override
  IOSink openWrite({FileMode mode = FileMode.write, Encoding encoding = utf8}) {
    return _file.openWrite(mode: mode, encoding: encoding);
  }

  // coverage:ignore-end

  @override
  Future<Uint8List> readAsBytes() {
    return _wrap(() async => _file.readAsBytes(), 'file.read');
  }

  @override
  Uint8List readAsBytesSync() {
    return _wrapSync(() => _file.readAsBytesSync(), 'file.read');
  }

  @override
  Future<List<String>> readAsLines({Encoding encoding = utf8}) {
    return _wrap(
        () async => _file.readAsLines(encoding: encoding), 'file.read');
  }

  @override
  List<String> readAsLinesSync({Encoding encoding = utf8}) {
    return _wrapSync(
      () => _file.readAsLinesSync(encoding: encoding),
      'file.read',
    );
  }

  @override
  Future<String> readAsString({Encoding encoding = utf8}) {
    return _wrap(
        () async => _file.readAsString(encoding: encoding), 'file.read');
  }

  @override
  String readAsStringSync({Encoding encoding = utf8}) {
    return _wrapSync(
      () => _file.readAsStringSync(encoding: encoding),
      'file.read',
    );
  }

  @override
  Future<File> rename(String newPath) {
    return _wrap(() async => _file.rename(newPath), 'file.rename');
  }

  @override
  File renameSync(String newPath) {
    return _wrapSync(() => _file.renameSync(newPath), 'file.rename');
  }

  @override
  Future<File> writeAsBytes(
    List<int> bytes, {
    FileMode mode = FileMode.write,
    bool flush = false,
  }) {
    return _wrap(
      () async => _file.writeAsBytes(bytes, mode: mode, flush: flush),
      'file.write',
    );
  }

  @override
  void writeAsBytesSync(
    List<int> bytes, {
    FileMode mode = FileMode.write,
    bool flush = false,
  }) {
    _wrapSync(
      () => _file.writeAsBytesSync(bytes, mode: mode, flush: flush),
      'file.write',
    );
  }

  @override
  Future<File> writeAsString(
    String contents, {
    FileMode mode = FileMode.write,
    Encoding encoding = utf8,
    bool flush = false,
  }) {
    return _wrap(
      () async => _file.writeAsString(
        contents,
        mode: mode,
        encoding: encoding,
        flush: flush,
      ),
      'file.write',
    );
  }

  @override
  void writeAsStringSync(
    String contents, {
    FileMode mode = FileMode.write,
    Encoding encoding = utf8,
    bool flush = false,
  }) {
    _wrapSync(
      () => _file.writeAsStringSync(
        contents,
        mode: mode,
        encoding: encoding,
        flush: flush,
      ),
      'file.write',
    );
  }

  String _getDesc() {
    return uri.pathSegments.isNotEmpty ? uri.pathSegments.last : path;
  }

  Future<T> _wrap<T>(Callback<T> callback, String operation) async {
    final desc = _getDesc();

    final currentSpan = _hub.getSpan();
    final span = currentSpan?.startChild(operation, description: desc);

    span?.origin = SentryTraceOrigins.autoFile;
    span?.setData('file.async', true);

    final Map<String, dynamic> breadcrumbData = {};
    breadcrumbData['file.async'] = true;

    if (_hub.options.sendDefaultPii) {
      span?.setData('file.path', absolute.path);
      breadcrumbData['file.path'] = absolute.path;
    }
    T data;
    try {
      // workaround for having the length when the file does not exist
      // or its being deleted.
      int? length;
      var hasLength = false;
      try {
        length = await _file.length();
        hasLength = true;
      } catch (_) {
        // ignore in case something goes wrong
      }

      data = await callback();

      if (!hasLength) {
        try {
          length = await _file.length();
        } catch (_) {
          // ignore in case something goes wrong
        }
      }

      if (length != null) {
        span?.setData('file.size', length);
        breadcrumbData['file.size'] = length;
      }

      span?.status = SpanStatus.ok();
    } catch (exception) {
      span?.throwable = exception;
      span?.status = SpanStatus.internalError();
      rethrow;
    } finally {
      await span?.finish();

      await _hub.addBreadcrumb(
        Breadcrumb(
          message: desc,
          data: breadcrumbData,
          category: operation,
        ),
      );
    }
    return data;
  }

  T _wrapSync<T>(Callback<T> callback, String operation) {
    final desc = _getDesc();

    final currentSpan = _hub.getSpan();
    final span = currentSpan?.startChild(operation, description: desc);

    span?.origin = SentryTraceOrigins.autoFile;
    span?.setData('file.async', false);

    final Map<String, dynamic> breadcrumbData = {};
    breadcrumbData['file.async'] = false;

    if (_hub.options.sendDefaultPii) {
      span?.setData('file.path', absolute.path);
      breadcrumbData['file.path'] = absolute.path;
    }

    T data;
    try {
      // workaround for having the length when the file does not exist
      // or its being deleted.
      int? length;
      var hasLength = false;
      try {
        length = _file.lengthSync();
        hasLength = true;
      } catch (_) {
        // ignore in case something goes wrong
      }

      data = callback() as T;

      if (!hasLength) {
        try {
          length = _file.lengthSync();
        } catch (_) {
          // ignore in case something goes wrong
        }
      }

      if (length != null) {
        span?.setData('file.size', length);
        breadcrumbData['file.size'] = length;
      }

      span?.status = SpanStatus.ok();
    } catch (exception) {
      span?.throwable = exception;
      span?.status = SpanStatus.internalError();
      rethrow;
    } finally {
      span?.finish();

      _hub.addBreadcrumb(
        Breadcrumb(
          message: desc,
          data: breadcrumbData,
          category: operation,
        ),
      );
    }
    return data;
  }

  // coverage:ignore-start

  @override
  Stream<FileSystemEvent> watch({
    int events = FileSystemEvent.all,
    bool recursive = false,
  }) =>
      _file.watch(events: events, recursive: recursive);

  @override
  Future<String> resolveSymbolicLinks() => _file.resolveSymbolicLinks();

  @override
  String resolveSymbolicLinksSync() => _file.resolveSymbolicLinksSync();

  @override
  Future<dynamic> setLastAccessed(DateTime time) => _file.setLastAccessed(time);

  @override
  void setLastAccessedSync(DateTime time) => _file.setLastAccessedSync(time);

  @override
  Future<dynamic> setLastModified(DateTime time) => _file.setLastModified(time);

  @override
  void setLastModifiedSync(DateTime time) => _file.setLastAccessedSync(time);

  @override
  Directory get parent => _file.parent;

  @override
  String get path => _file.path;

  @override
  File get absolute => _file.absolute;

  @override
  Future<bool> exists() => _file.exists();

  @override
  bool existsSync() => _file.existsSync();

  @override
  bool get isAbsolute => _file.isAbsolute;

  @override
  Future<DateTime> lastAccessed() => _file.lastAccessed();

  @override
  DateTime lastAccessedSync() => _file.lastAccessedSync();

  @override
  Future<DateTime> lastModified() => _file.lastModified();

  @override
  DateTime lastModifiedSync() => _file.lastModifiedSync();

  @override
  Future<int> length() => _file.length();

  @override
  int lengthSync() => _file.lengthSync();

  @override
  Future<FileStat> stat() => _file.stat();

  @override
  FileStat statSync() => _file.statSync();

  @override
  Uri get uri => _file.uri;

  // coverage:ignore-end
}
